home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / tchss141.zip / TCHESS.DOC < prev   
Text File  |  1987-11-30  |  16KB  |  397 lines
  1.  
  2.               Documentation for Turbo CHESS DOOR ver 1.41 - page 1
  3.                                         
  4.  
  5.                     Turbo CHESS DOOR for PCBoard 11.8 & 12.0
  6.                                         
  7.                            Copywrite Andrew Roy, 1987
  8.        
  9.        This program is released to the public domain.  There are a few
  10.        stipulations:
  11.        
  12.             1)  The files MAY NOT be distributed in modified form.
  13.             2)  All the files MUST be distributed in an ARC format.
  14.        
  15.        You MAY use this program free of charge however, I expect one of
  16.        the following:
  17.        
  18.             1)  Send a monetary contribution to help offset the cost of
  19.                 my time ($15 is suggested).  All contributions should be
  20.                 mailed to:
  21.        
  22.                       Andrew Roy
  23.                       Rt. 1 Box 235
  24.                       Blacksburg, Va 24060
  25.        
  26.                                        OR
  27.        
  28.             2)  Call my BBS and leave me a comment about the program.
  29.                 This comment may be a gripe, a bug report, a piece of
  30.                 advice, or total flattery; but I would like feedback.
  31.                 The BBS number is:
  32.        
  33.                       The MBT
  34.                       2 nodes, 120 MEG on-line (703)-953-2443
  35.        
  36.             3)  If you are the author of a DOOR program for PCBoard,
  37.                 please make it available to me as I have made mine to
  38.                 you, without requiring payment.
  39.        
  40.        Description of The Turbo CHESS DOOR
  41.        
  42.             The Turbo CHESS DOOR allows board members to play chess with
  43.             one another.  Some features include:
  44.             
  45.             o  Up to 99 games occurring at any time.
  46.             
  47.             o  The DOOR informs the participates of a CHECK, CHECKMATE,
  48.                or STALEMATE condition.
  49.             
  50.             o  The DOOR completely checks the legality of each move.
  51.             
  52.             o  The DOOR supports castling (with complete legality checks,
  53.                including castling while in check, castling over a
  54.                controlled square, and checking for the king or rook
  55.                having previously been moved.)
  56.             
  57.             o  The DOOR supports en passant captures.
  58.             
  59.             o  The DOOR supports pawn advancement allowing the player to
  60.                select any allowable piece.
  61.             
  62.             o  The screen displays a pictorial of the game including
  63.                information on the present move number, each player's last
  64.  
  65.  
  66.  
  67.  
  68.               Documentation for Turbo CHESS DOOR ver 1.41 - page 2
  69.                                         
  70.  
  71.                move, the date the last move was made, and the players'
  72.                names.
  73.             
  74.             o  DOOR users may view games being played by other users.
  75.             
  76.             o  DOOR users may view up to the last 100 moves in any game.
  77.                Including information on en passant and pawn advancement.
  78.             
  79.             o  The DOOR supports resignation.
  80.             
  81.             o  The DOOR has an undo feature that always a player to undo
  82.                his last move if his opponent has not yet moved.  Players
  83.                could alternately undo moves all the way to the beginning
  84.                of the game if desired.
  85.             
  86.             o  The DOOR supports two optional initial welcome screens and
  87.                one optional final screen.
  88.             
  89.             o  The DOOR keeps a record of the number of wins, losses and
  90.                draws for each player.
  91.             
  92.             o  The DOOR has a built-in HELP feature.
  93.             
  94.             o  The DOOR is network/share compatible.
  95.             
  96.             o  The DOOR will operate without the use of GUARD, WATCHDOG,
  97.                or PCBTrap as it has it's own internal COM routines.  It
  98.                will recycle properly on loss of carrier.
  99.             
  100.             o  The DOOR is fully compatible with Double DOS.
  101.             
  102.             o  The DOOR may be entered from the local terminal.
  103.             
  104.             o  The DOOR will handle Keyboard Timeout (set to 5 minutes),
  105.                or User Time Expired.  The DOOR will allow a user to spend
  106.                all of his remaining time before returning him to PCBoard,
  107.                or the SYSOP may cause the DOOR to only allow a set time
  108.                limit.
  109.             
  110.             o  The DOOR allows for data entry from the user or the SYSOP.
  111.             
  112.             o  The DOOR supports ANSI graphics.
  113.             
  114.             o  The DOOR automatically terminates "dead" games.  (Those in
  115.                which a move has not been made for over a month.)
  116.             
  117.             o  The DOOR prevents a normal user (non-SYSOP) from being
  118.                involved in more than 4 at a time.
  119.             
  120.             o  The DOOR has a local screen off and a logoff user control
  121.                at the local terminal.
  122.             
  123.             o  Tested and compatible with 19,200 BPS speeds.
  124.             
  125.        
  126.        Setting Up Turbo CHESS DOOR
  127.        
  128.             This section is designed to help you set up the Turbo CHESS
  129.             DOOR.  IT IS NOT DESIGNED TO TEACH YOU ABOUT DOOR SET UP.  If
  130.  
  131.  
  132.  
  133.  
  134.               Documentation for Turbo CHESS DOOR ver 1.41 - page 3
  135.                                         
  136.  
  137.             you do not know how to set up a DOOR, you should refer to you
  138.             PCBoard Manual.
  139.        
  140.             1) Place the program file (TCHESS.COM), the help file (HELP),
  141.                and the sample configuration file (TC.CFG) in your DOORS
  142.                subdirectory.  For the sake of illustration, I will assume
  143.                this to be C:\DOORS.
  144.             
  145.             2) Place the starting batch file (TCHESS), in the directory
  146.                where your PCBOARD.DAT file is located.
  147.             
  148.             3) Edit the TC.CFG file to reflect your system setup, you may
  149.                use TC.CFG as a guide.  The configuration file appears in
  150.                the following order:
  151.             
  152.        Line 1   -   C:\BBS     <- The PCBoard directory
  153.        Line 2   -   HELP       <- The name of the HELP file (This should
  154.                                   only be changed if you decide to write
  155.                                   your own HELP file.)
  156.        Line 3   -   INIT1      <- The name of the first welcome screen
  157.                                   for the Turbo CHESS DOOR.  This is
  158.                                   optional, when Turbo CHESS DOOR runs,
  159.                                   it will look for this file.  If it can
  160.                                   not find it, then it will simple not
  161.                                   display anything.  This may be a
  162.                                   complete path name.  It should NOT be
  163.                                   left blank.
  164.        Line 4   -   INIT2      <- This is the name of a second welcome
  165.                                   screen for the Turbo CHESS DOOR.  It
  166.                                   operates just like the first one.
  167.        Line 5   -   FINAL1     <- This is the name of a final screen for
  168.                                   the Turbo CHESS DOOR.  It will be
  169.                                   displayed when the user exits the DOOR.
  170.                                   Aside from this, it operates exactly as
  171.                                   the welcome screens.
  172.        Line 6   -   BBS Name   <- Enter your BBS name here, it will be
  173.                                   displayed on a title screen.
  174.        
  175.        NOTE *** - If you are running a multinode PCBoard setup, then you
  176.                   should have one configuration file for each node.  For
  177.                   example, assume you run a two node BBS where the
  178.                   PCBoard directory for node 1 is C:\BBS and the PCBoard
  179.                   directory for node 2 is C:\BBS2.  Your two
  180.                   configuration files would be:
  181.        
  182.        TC1.CFG                        TC2.CFG
  183.        ============================================================
  184.        C:\BBS                         C:\BBS2
  185.        HELP                           HELP
  186.        INIT1                          INIT1
  187.        INIT2                          INIT2
  188.        FINAL1                         FINAL1
  189.        BBS Name                       BBS Name
  190.        
  191.             4) Edit the TCHESS file to reflect how to start the Turbo
  192.                CHESS DOOR.
  193.        
  194.                An example follows:
  195.        
  196.        Line 1 -   ECHO OFF        <- Shut off ECHO for looks
  197.  
  198.  
  199.  
  200.               Documentation for Turbo CHESS DOOR ver 1.41 - page 4
  201.                                         
  202.  
  203.        Line 2 -   CD \DOORS       <- Change directories to DOORS
  204.        Line 3 -   TCHESS 1 TC.CFG <- Run TCHESS Com# Configfile [time
  205.                                      limit]
  206.        Line 4 -   CD \BBS         <- Change back to PCBoard directory
  207.        Line 5 -   ECHO ON         <- Reactivate ECHO
  208.        Line 6 -   BOARD           <- Restart PCBoard
  209.        
  210.        NOTE *** - If you are running a multinode PCBoard setup, then the
  211.                   starting batch files will be different for each node.
  212.                   For example, assume you run a two node system where the
  213.                   PCBoard directory for node 1 is C:\BBS, it uses COM1
  214.                   and the configuration file is TC1.CFG.  The PCBoard
  215.                   directory for node 2 is C:\BBS2, it uses COM2 and the
  216.                   configuration file is TC2.CFG.  The batch files would
  217.                   be:
  218.        
  219.        TCHESS for Node 1              TCHESS for Node 2
  220.        (placed in directory C:\BBS)   (placed in directory C:\BBS2)
  221.        ============================================================
  222.        Line 1 - ECHO OFF              ECHO OFF
  223.        Line 2 - CD \DOORS             CD \DOORS
  224.        Line 3 - TCHESS 1 TC1.CFG      TCHESS 2 TC2.CFG
  225.        Line 4 - CD \BBS               CD \BBS2
  226.        Line 5 - ECHO ON               ECHO ON
  227.        Line 6 - BOARD                 BOARD
  228.        
  229.             5) Add an entry in the DOORS.DAT file in you MAIN
  230.                subdirectory for TCHESS.
  231.        
  232.             That completes the installation of The Turbo CHESS DOOR.
  233.        
  234.        Advanced Use of The Turbo CHESS DOOR
  235.        
  236.             a) Typically, the Turbo CHESS DOOR is called by the
  237.                following:
  238.        
  239.                       TCHESS Com# Configfilename.
  240.                
  241.                Optionally, the DOOR may be called as follows:
  242.                
  243.                     TCHESS Com# Configfilename Timelimit
  244.        
  245.                where time limit is the maximum amount of time the user
  246.                will be allowed to stay in the DOOR before the DOOR ejects
  247.                him.  This is optional and if not supplied, the user is
  248.                allowed to spend all of his remaining time in the DOOR.
  249.        
  250.             b) If the DOOR is run from the local terminal, everything
  251.                will work properly.  However, if you would like to run the
  252.                program WITHOUT USING PCBOARD, this can still be done.  If
  253.                the program is called as follows:
  254.        
  255.                     TCHESS LOCAL Configfilename  (LOCAL has been
  256.                                                   substituted for Com#)
  257.        
  258.                then the DOOR will not look for the PCBOARD.SYS file
  259.                (which would not be there) and assumes the user is the
  260.                SYSOP.
  261.        
  262.  
  263.  
  264.  
  265.  
  266.               Documentation for Turbo CHESS DOOR ver 1.41 - page 5
  267.                                         
  268.  
  269.             c) F1 will cause the present user to be logged off Turbo
  270.                CHESS DOOR and returned to PCBoard.  F2 will toggle the
  271.                local screen on and off.
  272.        
  273.        Program Notes
  274.        
  275.             1)  It is MUCH easier to understand the graphics board than
  276.                 the non-graphics board.  The non-graphics board uses only
  277.                 true ASC characters (no IBM extended characters) so non-
  278.                 IBM computers can use the DOOR.
  279.             
  280.             2)  The program does not support the 50 move stalemate rule
  281.                 although all of the necessary record keeping is being
  282.                 done at present.  A later version may support this.  The
  283.                 program does not support the thrice repeated sequence
  284.                 rule and will probably never support this.
  285.        
  286.        Appendix
  287.        
  288.             CHREPORT.COM
  289.        
  290.                  CHREPORT.COM will create a list of the top scoring
  291.                  players of The Turbo CHESS DOOR.  CHREPORT.COM must be
  292.                  in the same directory as TCHESS.COM.  When it is run, it
  293.                  will read the CHSCORE file that is created and
  294.                  maintained by TCHESS.COM.  It will sort the members,
  295.                  ordering them according to their wins vs losses.  It
  296.                  will print the report to the screen, however, the output
  297.                  is redirectable.  This is useful for automatically
  298.                  creating a bulletin that lists the top players.  Assume
  299.                  your PCBoard GEN directory is C:\GEN and the following
  300.                  line is in your EVENT.SYS file:
  301.        
  302.                       CHREPORT > C:\GEN\BLT2
  303.        
  304.                  This would cause BLT2 (PCBoard Bulletin 2) to contain a
  305.                  list of the best players.
  306.        
  307.                  CHREPORT.COM may optionally be called with a parameter
  308.                  indicating how many players to list.  If no parameter is
  309.                  given, then the report contains all players who have
  310.                  won, lost, or drawn in Turbo CHESS DOOR.  If a parameter
  311.                  is given, then that parameter is assumed to be the
  312.                  number of players you wish to list.
  313.                  
  314.                  An example:
  315.                       
  316.                       CHREPORT 10    This would list the top 10 players.
  317.        
  318.             Special Thanks :
  319.        
  320.                  I would like to thank Carl Evans, SYSOP of The WAR BOARD
  321.                  for helping with the beta testing of Turbo CHESS DOOR.
  322.                  His comments, and bug reports were tremendously helpful.
  323.        
  324.                       The WAR BOARD - (714) 989-7596
  325.        
  326.                  I would like to thank the users of my BBS, The MBT, for
  327.                  their help in alpha and beta testing of Turbo CHESS
  328.  
  329.  
  330.  
  331.  
  332.               Documentation for Turbo CHESS DOOR ver 1.41 - page 6
  333.                                         
  334.  
  335.                  DOOR.  Their comments were helpful in all aspects of the
  336.                  programs development.
  337.        
  338.             Program History :
  339.        
  340.                  Version
  341.        
  342.                  1.00 - 1.30 Alpha and beta Versions
  343.                  
  344.                  1.31 -      First version released to public
  345.                  
  346.                  1.32 -      Fixed bug in initial creation of CHSCORE
  347.                              file.  Changed color of text on status line
  348.                              from green to white for better visibility.
  349.                              (Not released to public.)
  350.                  
  351.                  1.40 -      Added logic to allow no more that 4 games
  352.                              per user.  (Not released to public.)
  353.                  
  354.                  1.41 -      Added logic to kill off "dead" games.
  355.                              Modified CHREPORT.COM to output a message
  356.                              when no games had been completed.  Changed
  357.                              centering of BBS name on opening screen to
  358.                              better handle odd character names.  Fixed
  359.                              bug that caused illegal game when user
  360.                              entered illegal 1 character command at move
  361.                              prompt.  (Second version released to
  362.                              public.)
  363.        
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.